Skip to content

chore(docs): add normalized markdown table checker (prevent merge conflicts)#3460

Merged
markijbema merged 2 commits into
mainfrom
chore/normalized-md-tables
May 25, 2026
Merged

chore(docs): add normalized markdown table checker (prevent merge conflicts)#3460
markijbema merged 2 commits into
mainfrom
chore/normalized-md-tables

Conversation

@kilo-code-bot
Copy link
Copy Markdown
Contributor

@kilo-code-bot kilo-code-bot Bot commented May 25, 2026

Summary

  • Adds script/check-md-table-padding.ts (adapted from kilocode) to enforce compact, non-padded markdown tables across the repo
  • Adds *.md to .prettierignore so prettier won't re-pad table cells and create spurious diffs
  • Adds a CI workflow (.github/workflows/check-md-table-padding.yml) that runs the check on every PR touching markdown files
  • Documents the rules in AGENTS.md under a new "Markdown Tables" section
  • Normalizes all 59 existing markdown files that had padded tables via --fix

The root cause of the problem: prettier aligns table cells by column width, so any content change causes every row in the table to be re-padded, polluting diffs with unrelated whitespace changes. Excluding *.md from prettier and enforcing compact table format prevents this entirely.

Verification

  • Run bun run script/check-md-table-padding.ts — should report 132 file(s) checked, no padded tables found.
  • Verify CI workflow appears in .github/workflows/check-md-table-padding.yml.

Visual Changes

N/A

Reviewer Notes

The skip() function in the script excludes only .changeset/, CHANGELOG.md, and node_modules/ — all other tracked *.md files are checked. The kilocode version also skipped packages/ (fork upstream) and .opencode/glossary/ (translator-readable aligned tables), neither of which apply to this repo.

@kilo-code-bot
Copy link
Copy Markdown
Contributor Author

kilo-code-bot Bot commented May 25, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Executive Summary

Full review of 62 files across 2 commits — purely mechanical changes: a new markdown table enforcement script, CI workflow, .prettierignore update, AGENTS.md documentation, and mechanical table reformatting across 59 markdown files. No logic, security, or behavioral concerns found.

Files Reviewed (62 files)

TypeScript:

  • script/check-md-table-padding.ts — new enforcement script; logic is correct, fenced-code-block tracking, separator detection, and fix/check modes all work as intended

CI:

  • .github/workflows/check-md-table-padding.yml — runs on PRs touching *.md files; uses pinned actions/checkout@v4 and oven-sh/setup-bun@v2; no issues

Config:

  • .prettierignore — adds *.md exclusion with explanatory comment; correct

Documentation (new/updated sections):

  • AGENTS.md — new Markdown Tables section documents rules and enforcement commands

Markdown files reformatted (58 files — mechanical table normalization only):

  • .agents/skills/chat-sdk/SKILL.md
  • .agents/skills/durable-objects/SKILL.md
  • .agents/skills/durable-objects/references/rules.md
  • .agents/skills/kilo-design/NOTICE.md
  • .agents/skills/kilo-design/SKILL.md
  • .agents/skills/kilo-design/reference/color-and-contrast.md
  • .agents/skills/kilo-design/reference/interaction-design.md
  • .agents/skills/kilo-design/reference/kilo-brand.md
  • .agents/skills/kilo-design/reference/motion-design.md
  • .agents/skills/kilo-design/reference/spatial-design.md
  • .agents/skills/kilo-design/reference/typography.md
  • .agents/skills/kilo-design/reference/ux-writing.md
  • .agents/skills/workers-best-practices/SKILL.md
  • .agents/skills/workers-best-practices/references/review.md
  • .agents/skills/wrangler/SKILL.md
  • .github/pull_request_template.md
  • .plans/contributor-champion-credits.md
  • .plans/db-perf-improvements.md
  • .plans/experimental-models-1.md
  • .plans/experimental-models-2.md
  • .plans/gastown-cloud-proposal-d.md
  • .plans/gastown-town-centric-refactor.md
  • .plans/kiloclaw-billing-credits.md
  • .plans/kiloclaw-billing-promo-codes.md
  • .plans/kiloclaw-credits-testing.md
  • .plans/migrate-email-to-mailgun.md
  • .plans/monorepo-migration-prompt.md
  • .plans/monorepo-restructure-summary.md
  • .plans/monorepo-restructure.md
  • .plans/product-analytics-improvements.md
  • .plans/standard-first-month-credit-discount.md
  • .specs/impact-affiliate-tracking.md
  • .specs/impact-referrals.md
  • .specs/kiloclaw-billing.md
  • .specs/kiloclaw-controller.md
  • DEVELOPMENT.md
  • apps/web/src/docs/network-compliance-diagram.md
  • apps/web/src/emails/AGENTS.md
  • apps/web/src/lib/security-agent/README.md
  • design.md
  • docs/do-sqlite-drizzle.md
  • services/cloud-agent-next/test/e2e/README.md
  • services/deploy-infra/dispatcher/http-requests/README.md
  • services/gastown/docs/e2e-pr-feedback-testing.md
  • services/gastown/docs/post-deploy-monitoring.md
  • services/gmail-push/README.md
  • services/kiloclaw-billing/docs/observability.md
  • services/kiloclaw/AGENTS.md
  • services/kiloclaw/DEVELOPMENT.md
  • services/kiloclaw/README.md
  • services/kiloclaw/docs/instance-features.md
  • services/kiloclaw/docs/secret-catalog.md
  • services/kiloclaw/e2e/docker-image-testing.md
  • services/kiloclaw/google-setup/README.md
  • services/wasteland/MONITORING.md
  • services/wasteland/docs/e2e-testing.md
  • services/wasteland/docs/wl-cli-reference.md
  • services/webhook-agent-ingest/README.md

Reviewed by claude-4.6-sonnet-20260217 · 914,466 tokens

Review guidance: REVIEW.md from base branch main

@kilo-code-bot kilo-code-bot Bot force-pushed the chore/normalized-md-tables branch from 4b49ad9 to 5193fb2 Compare May 25, 2026 12:36
@markijbema markijbema enabled auto-merge (squash) May 25, 2026 12:40
Copy link
Copy Markdown
Contributor

@alex-alecu alex-alecu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have liked it being split in 2 commits:

  1. Implement CI check
  2. Apply formatter to existing files

So I could review just the first commit

@markijbema markijbema merged commit 98881f1 into main May 25, 2026
20 checks passed
@markijbema markijbema deleted the chore/normalized-md-tables branch May 25, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants